home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / x / animutil / xanim229.lha / xanim / xanim.readme < prev    next >
Encoding:
Text File  |  1992-01-08  |  4.1 KB  |  152 lines
  1.  
  2.  
  3. XAnim was written to display various types of animations in an X11 
  4. environment(currently it only supports Pseudo Color Displays). The
  5. intent was/is to make it fairly easy to add new animation types as
  6. they are developed.
  7.  
  8. Before you compile, edit the Makefile to choose your favourite compiler,
  9. optimization flags and to indicate where the X11 libraries are located.
  10. When compiling you might see warnings about zero sized structure members or
  11. zero subscripts. This is because some of the data structures aren't
  12. ANSI C compliant. So far, the Mips, Sun and DG compilers can handle this.
  13.  
  14. Once compiled, xanim can display the following:
  15.  
  16.     1) FLI anims
  17.     2) IFF type 3,5,J and l(small L not 1) anims
  18.     3) IFF color cycling
  19.     4) IFF images (EHB included, but HAM shown as 332)
  20.     5) GIFs (with multiple images)
  21.     6) a kludgy text file listing gifs and what order to show them in
  22.     7)  any combination of the above on the same command line.
  23.  
  24. NOTES:  This source code isn't the cleanest and it's currently 
  25.         not commented very well. Both of these have high priority
  26.     now.(it's getting better though :^)
  27.  
  28.  
  29. Usage and Options:
  30.  
  31. xanim [ [+|-]opts ...] animfile [ [ [-opts] animfile] ... ]
  32.  
  33. A + turns the following options on and a - turns them off.
  34. Option f,j and l ignore leading + and -'s.
  35.  
  36. Options:
  37.  
  38.     b    uncompress animations up front. GIFs are automatically
  39.         uncompressed and there currently isn't support for
  40.         uncompressing IFF type J animations. Careful, use of
  41.         this flag can eat up a lot of memory.
  42.  
  43.     c    This is used to tell XAnim that and IFF type 3 or 5
  44.         animation is non-looping and that it needs to treat
  45.         it a bit differently. If an IFF type 3 or 5 animation
  46.         looks right the 1st time and is screwed up on the 2nd
  47.         loop, you probably need to use this flag.
  48.  
  49.     d    debug. Spews a lot of stuff to the screen.
  50.  
  51.     f#    Adds fading between animation files. The colormap
  52.         which fade to black in 16 frames. # is the delay of
  53.         each of these frames. -f0 turns off fading.
  54.  
  55.     i    Scale image vertically by 1/2.(Odd display lines
  56.         aren't displayed). 
  57.  
  58.         j#    # is number of milliseconds between frames
  59.           (default is 17 unless specified inside the
  60.           the animation itself).
  61.  
  62.     l#    loop following files # number times before moving on to
  63.         the next file. default is 1.
  64.         
  65.     o    turns on certain optimizations. Turning this off would only
  66.           be useful if you are buffering the anim and wish to run
  67.           the anim backwards. default is on.
  68.  
  69.     r     turns color cycling off(IFF cycling images).
  70.  
  71.         s    prevents window from resizing to match image
  72.         size. Window is the size of largest image.
  73.         default is on.
  74.  
  75.     u    when single stepping, anim is played until image is 
  76.         updated/changed.(a new cmap is not considered an update).
  77.         default is on.
  78.  
  79.     v    verbose. Tells you image sizes, number of deltas etc.
  80.  
  81. Anim Window Commands:
  82.  
  83.     q    quits.
  84.     g    move to anim file after a cycling IFF image.
  85.     s    stop color cycling if started.
  86.     r    restore original color once stopped (s).    
  87.     space    toggle. starts/stops animation
  88.     ,    go back one frame within file
  89.     .    go forward one frame within file
  90.     <    go back to start of previous file
  91.     >    go forward to start of next file
  92.  
  93.  
  94. Examples:
  95.  
  96.     To display a single animation:
  97.  
  98.         xanim iff3.anim
  99.  
  100.     To display a nonlooping IFF animation:
  101.  
  102.         xanim +c iff3.anim
  103.  
  104.     To display A.fli 3 times, B.anim and C.movie 2 times each and D.fli
  105.     once before repeating:
  106.  
  107.         xanim -l3 A.fli -l2 B.anim C.movie -l1 D.fli
  108.     or 
  109.         xanim +l3 A.fli +l2 B.anim C.movie +l1 D.fli
  110.  
  111.     To fade to black after A.fli B.fli and C.fli but not after D.fli:
  112.  
  113.         xanim +f3 A.fli B.fli C.fli +f0 D.fli
  114.  
  115.     To see A.anim real slow:
  116.  
  117.         xanim +j50 A.anim
  118.  
  119.     To display title image for a while then fade into an animation at
  120.     normal speed:
  121.  
  122.         xanim +f3 +j200 title.gif +j0 anim.gifanim
  123.  
  124.     To show 1st anim unbuffered at half height and 2nd anim buffered
  125.     at full height:
  126.  
  127.         xanim +i first.anim -i+b second.anim
  128.     or
  129.         xanim +i first.anim -i +b second.anim
  130.     
  131.  
  132.  
  133. A series of GIF's can be displayed as:
  134.  
  135.     xanim im_0.gif im_1.gif im_2.gif ... im_36.gif
  136.  
  137.  or
  138.  
  139.     xanim im_*.gif
  140.  
  141.  or
  142.  
  143.     xanim im.txt
  144.  
  145.  or
  146.  
  147.     xanim im.gifanim
  148.  
  149. where im.txt is a txt file(a list of images, see xanim.doc for more details).
  150. and im.gifanim is one file composed of im_0.gif through im_36.gif.
  151.  
  152.